Configuring AMI communications system settings

  1. Go to System Administration > Sys Admin > System Settings.

  2. From the Section dropdown menu, select AMI Billing Export.

  3. Configure the following parameters, and then click Save.

AMI Communication:

  • Contingency Read Status Update Polling Frequency in Minutes. Defines the frequency, in minutes, to check for received data. This is the number of minutes IEE waits before polling for updated contingency read statuses. If the data is complete the contingency read status changes to Success. The default value is 15 minutes.

  • Enable Contingency Read Retries. Determines whether the system should re-submit contingency read requests to the collection system if all of the requested intervals have not been received and imported by the end of the contingency read timeout period. IEE can automatically retry a failed contingency read request one time. If the second request fails, the request is marked with a failed status, and a new request must be created manually. Select True to enable one automatic retry. Select False to disable contingency read retries.

  • Enable Self Read Options. Determines if the device communications ReportSelfReadOption optional property is included with the ContingencyRead and RemoteInterrogation web service operations. Setting the parameter value to True affects the Remote Interrogation task template and the Gap Fill Contingency Reads.

    Set the value to True to enable the option of choosing between the values of Retrieve All In Period or Retrieve at End Time in the AMI Remote Interrogation task template. When true, the Gap Fill Contingency Reads set the SelfReadOption to Retrieve at End Time.

    If False, these operations use the last midnight self-read value for interrogations and GFI operations.

    Note: This setting is not expected to affect performance. However, setting the value to true and selecting Retrieve All in Period on the AMI Remote Interrogation task template can cause an increase in the number of register reads to import. If you experience an increase in reads and it affect performance, you can mitigate the performance issue by changing the settings to false or Retrieve at End Time.

  • File Batching Size Threshold in Bytes. Defines when IEE creates the batch file. The batch file is created when the data size exceeds this threshold. To enter the batch file size, click in the entry box and type the number. Enter the batch file size in bytes.

  • File Batching Time Threshold in Seconds. Defines the number of seconds to wait before IEE creates a new HVRI batch file. The timer starts when the last HVRI batch file is created. Enter the number of seconds in whole numbers.

  • Identify Previous Billing Register Readings. Determines if a register reading associated with a Previous Billing value is identified so that it can be saved to a separate service point channel.

    When set to True, DeviceComm differentiates between Previous Billing Register readings and other register readings. If the source attribute of the register value is Demand Reset, DeviceComm appends _pb to the external UOM and IEE saves the reading to a separate channel under the service point, which maps to the _pb external UOM.

    When set to False, the feature is disabled, and Previous Billing Register readings are treated as other register readings.

    With this feature, IEE identifies readings associated with a Demand Reset, and IEE differentiates them from other register readings by simply changing the UOM value of these registers.

    If the setting is True but there is not a service point channel defined with the expected UOM code or the UOM does not have an external system UOM mapping, the reading is handled as any other reading.

  • Keep Device Event Arguments. Determines whether the extra metadata (sometimes called device arguments) that can be received in meter events is preserved in IEE. Select True to enable. If False, the device events are imported but the metadata is ignored. If you do not require this metadata, consider selecting False since it decreases the amount of information that is processed and stored. This setting only affects Events that are imported through the Device Comm service. Device Events imported directly through the file-based IEE Event XML format always save the metadata regardless of the value in this setting.

  • Maximum Contingency Read IDs Count. Defines the maximum number of entities that are allowed in a single Contingency Read by List request. Enter a whole number between 1 and 10000.

    The Contingency Read request can contain the following entities:

    • Endpoint ID

    • Meter ID

    • Service Point ID

      This setting limits the scale of an AMI Contingency Read by List request to prevent performance issues that can result from entering a large number of IDs.

  • Maximum Interrogation Request Period in Days. Defines the number of days for an interrogation period. Enter the number of days in whole numbers.

  • Number of Days to Keep Requests Before Purging. Defines the number of days to keep the requests stored in the DeviceCommLog. Enter the number of days to keep the request before the requests are purged.

  • Polling Frequency in Seconds. Determines the number of seconds to wait between when the synchronous DeviceComm Web service polls the collection engine to retrieve results. Enter the time in seconds. The system waits this amount of seconds before retrieving results.

    Note: The IEE interactive communications user interface calls the synchronous DeviceComm Web service. Therefore, the asynchronous DeviceCommAsyncService Web service does not use this setting as it relies on a callback from the collection system to retrieve results.

  • Remote Disconnect Updates Meter Status. Determines whether a remote disconnect changes the meter status to inactive. Select True to enable. If False, the meter status remains active after performing a remote disconnect. By leaving the meter status active, the (active) disconnected meters can continue to be read and run through the normal VEE process.

  • Service Payload Logging Directory. Determines the directory path used to store message log files that are generated between web services and clients.

    Configure a valid directory path prior to specifying the path here. This feature is turned on when you specify the valid path. To turn off the logging feature, leave this setting blank. If the directory does not exist or if the entry is left blank, then no logging is performed. If the process performing the logging does not have permission to write to the directory or if there is inadequate disk space, an exception is written to the web service log indicating the failure reason.

    IEE creates a log file every three (3) minutes. Web service processing may be slower when this feature is turned on. This setting is most often used to debug interrogation issues between IEE and head end systems.

    Because IEE often translates data from the head end system format into the IEE format, logging the original payload helps determine which system is exhibiting issues. This allows for more focused troubleshooting efforts.

  • Timeout for Asynchronous Operations in Minutes. Defines the number of minutes to allow the operations to complete before the operations time-out. The default value is 1440 minutes.

  • Timeout for Contingency Read Operations in Minutes. Defines the number of minutes to allow the operations to complete before the operations time-out. The default value is 20 minutes.

  • Timeout for Interactive Operations in Minutes. Defines the number of minutes to allow the operations to complete before the operations time-out. The default value is 1 minute.

  • Fixed Network Adapter Settings Reading Import Directory. Defines the directory that IEE monitors for incoming Fixed Network Collection Engine (FN CE) reading XML files. This is the directory that IEE uses to determine which files that were received from the FN CE to import. The files in this directory are a subset of those in the Received Directory. For more information see the Received Directory system setting. The directory can be specified with UNC path names and supports standard IEE macros.

    The FN CE writes all XML reading files to this directory. These files can be responses to AMI Contingency Reads, AMI Interactive Communications requests, AMI Remote Interrogations, and GapFill requests. IEE’s DeviceComm service inspects each file that is received in this directory to determine if the file is a response to an AMI Interactive Communications request for interval data or for register reads. If the DeviceComm service determines that the file is in response to a pending AMI Interactive Communications request, the file is moved to the FN Receive Directory\backup folder, which is automatically created as needed. Otherwise, the file is moved to the FN Import Directory for import into IEE.

    If the following conditions are true, the file is not identified as a pending AMI Interactive Communications request:

    • IEE is not configured to receive readings from a FN CE.

    • There are no outstanding AMI Interactive Communication requests.

    • The file contains more than one entity ID; the AMI Interactive Communications works only on one specific meter at a time.

    • The entity ID and date range in the file do not match any pending AMI Interactive Communications requests.

  • Receive Directory. Defines the UNC path to file directory that IEE monitors for data files that are written by the Fixed Network Collection Engine (FN CE) for export.

    The FN CE writes all XML reading files to this directory. These files can be responses to AMI Contingency Reads, AMI Interactive Communications requests, AMI Remote Interrogations, and GapFill requests. IEE’s DeviceComm service inspects each file that is received in this directory to determine if the file is a response to an AMI Interactive Communications request for interval data or for register reads. If the DeviceComm service determines that the file is in response to a pending AMI Interactive Communications request, the file is moved to the FN Receive Directory\backup folder, which is automatically created as needed. Otherwise, the file is moved to the FN Import Directory for import into IEE.

    If the following conditions are true, the file is not identified as a pending AMI Interactive Communications request:

    • IEE is not configured to receive readings from a FN CE.

    • There are no outstanding AMI Interactive Communication requests.

    • The file contains more than one entity ID; the AMI Interactive Communications works only on one specific meter at a time.

    • The entity ID and date range in the file do not match any pending AMI Interactive Communications requests.

Gap Fill Bill Confirmation:

  • Stop Gap Fill Interrogation for Billed Version. Determines whether IEE replaces gaps in the reading data after IEE has calculated the billing determinants for that gap. For example, IEE may have used estimated data to calculate billing determinants for that gap. To prevent IEE from replacing the gaps, select Stop Gap Fill at Billing Calculation. This helps ensure that the version of the read that was used to calculate determinants is correctly flagged as the billed version. To allow IEE to replace the gaps when the missing readings arrive even if billing determinants were calculated, select Never.

  • Gap Fill Bill Contingency Read Parameters. Enter True for each type of data that you want to import during a contingency read call-down to the head end system. These parameters control the settings on the contingency request and if the collection system supports that type of data, it is returned in the results of the request. Enter False for types of data that you do not need to import. Some data, even if requested, may not be stored in IEE unless the system is configured to receive it. For example, network statistics may be returned but not stored.

  • Perform Demand Reset. Set demand values in the metering device to zero.

  • Retrieve Home Network Data. Determines whether to retrieve information about a customer's home network that is compatible with AMI devices, for example a Zigbee network.

  • Retrieve Instantaneous Data. Determines whether metering devices that are programmed to retrieve real-time instantaneous values can retrieve this data.

  • Retrieve Last Demand Reset. Defines whether IEE retrieves the date and time of the last demand reset. This is the date and time you last set demand values in the metering device to zero.

  • Retrieve Load Profile Data. Defines whether IEE retrieves load profile data.. Defines the interval data accumulated for user-specified discrete blocks of time. Also called mass memory data or interval pulse data.

  • Retrieve Log Events. Defines whether IEE retrieves the meter event log file.

  • Retrieve Network Statistics. Determines whether IEE retrieves network statistic information during a remote interrogation.

  • Retrieve Prior Self Read. Determines which self reads to retrieve from meter devices that are programmed to read and store their own channel values. The valid values are as follows:

    • True. Manual AMI remote interrogation tasks can retrieve either the most recent self read within the reading period or up to 12 self reads that occurred within the reading period. Scheduled and recurring AMI interrogation tasks can retrieve the most recent self read that occurred within the reading period.

    • False. AMI remote interrogation tasks can retrieve the most recent self read that was recorded by the device. This is the self read from the most recent midnight and may have occurred after the end of the reading period.

  • Retrieve Recent Registers. Defines whether IEE retrieves the registers.

  • Retrieve Voltage Monitor Data. Determines whether to retrieve voltage monitor data from the meter.

Gap Fill Interrogation:

  • Allow Gap Fill Interrogations for Non PBC Meters. Determines whether contingency reads initiated by the Gap Fill process are issued for meters that are not associated with a Meter Program. Select True to issue Gap Fill interrogations. Select False to disable this setting. For meters that are associated with Meter Programs, this behavior is determined by the Meter Capabilities.

  • Days to Retain Data. Defines the number of days to retain the Gap Fill Interrogation data. The system stores the date ranges and IDs that need to be gap filled. After the number of days defined with this setting, the retained gap fill interrogation data is removed from the system and no further gap fill interrogations are performed.

  • GFI Rollup Enabled. Determines whether to enable the GFI gap detection and rollup process. Select True to enable the GFI rollup or False to disable it.

    For example, if you are running an ARI estimation bypass that results in a large % of missing reads, this could result in a large overhead of work for the GFI rollup thread. When the GFI rollup detects many gaps, it creates corresponding Contingency Queues (CQ) items. When the missing readings are imported, the GFI rollup works to close the CQ items. By setting this value to False, you can disable the GFI rollup until the missing readings are imported to avoid such a situation.

    Keeping the value as True while encountering an Estimation Bypass scenario can decrease performance of the GFI process and create an unnecessarily large number of CQ items.

  • Maximum Allowed Contiguous Gap Hours for Meter. Defines the number of hours of contiguous gaps that the meter is allowed to have before it triggers a service order request. The Service Order module must be installed for this functionality to trigger service orders.

  • Maximum Gap Hour for Gap Entry Generation. Defines the maximum gap allowable. The recommended default is 120. You must activate this functionality by including a gap check rule in the import validation. Contingency requests are only triggered when the gap is smaller than this setting.

  • Maximum Meter Communication Failure Count Retry. Defines the number of times to retry if there is a communication failure to the collection engine.

  • Maximum Meters Per Request. Defines the maximum number of meters to interrogate for each contingency request.

  • Maximum Read Retry Count. Defines the maximum number of times to retry the interrogation if there is no response from the meter.

  • Maximum Requests Per Minute. Defines the number of gap fill requests to process per minute.

  • Meter Communication Wait Timeout Minutes. Defines the number of minutes to wait for the collection engine to respond to a request.

  • Meter Read Timeout in Minutes. Defines the number of minutes to wait for a meter to respond with the gap fill data before re-sending the request.

  • Minimum Gap Size in Minutes. Defines the time required for a gap to be identified as an interrogation candidate. Enter the time in minutes. Contingency requests are only triggered when the gap is larger than this setting.

  • Reading Gap Check Wait Time in Minutes. Defines the number of minutes to wait before checking for new reading gaps in the database. This setting controls how often the gap fill interrogation service sweeps through its candidate list to process interrogation requests.

  • Reading Gap Process Chunk Size. Defines the maximum number of service point channels that the GFI service processes in each chunk when creating meter readings requests from missing data. This number limits the number of rows fetched at any one time from the ReadingPeriodWithStatusID database table for processing into contingency queue records.

    The value entered represents the maximum number of rows to fetch, at one time, from the ReadingPeriodWithStatusID database table to process into contingency queue records.

    The IEE installer populates many of these parameters with default values. The default value might not be the recommended or optimal setting for your specific IEE implementation. You must tune these values to achieve optimal system performance. Use this setting to tune IEE based on the available resources on the database or application servers.

    Note: For customers who upgraded to IEE 8.1, in previous versions of IEE the value in this setting represented the number of readings. As a general guideline to help you convert the value from the number of readings to the maximum number of service point channels, use the following formula. Take the value used in your previous version of IEE and divide it by the daily number of readings. Use the derived value as the starting point to tune this setting.

  • Gap Fill Interrogation Settings Contingency Queue Process Chunk Size. Defines the number of contingency queue rows to process at a time.

  • Contingency Queue Save Chunk Size. Defines the number of contingency queue rows to save per transaction.

  • Do Not Interrogate Window. Defines the daily window of time to disable gap fill interrogations. Configure the values to all zeros (00:00:00 – 00:00:00) to always enable gap fill interrogation (GFI) interrogations.

  • Do Not Rollup Window. Defines the daily window of time to disable GFI roll-ups. Configure the values to all zeros (00:00:00 – 00:00:00) to always enable GFI roll-ups.

  • Service Order Request Creation Chunk Size. Defines the number of meters that GFI batches together when creating service orders requests. The Service Order module must be installed for this functionality to trigger service order requests.